dxp-ux
Retrieve UsageConsumption (TMF-677) - PR
/usageConsumptionReport [GET]
Key considerations for PR Market
- This resource is only applicable for PR Market only
URL
https://[localhost]:[port]/dxp-ux/v1/{businessId}/usageConsumptionReportURL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, PR etc.) identifying the business unit. | Y |
Header
| name | value | description | required |
|---|---|---|---|
| client_id | string | The client_id identifying the channel. | Y |
| client_secret | string | Password associated with the client_id. | Y |
| X-Correlation-ID | string | An identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications. Note - Mule default behavior creates a sample x-correlation-id field if value is not passed from client, API will use this value in case value is not passed in API request | Y |
| channelId | string | Expected value APP. this is applicable when BU=PR | cond.Y |
| targetSystem | string | Expected value Matrixx. this is applicable when BU=PR | cond. Y |
QueryParameter
| name | value | description | required |
|---|---|---|---|
| product.publicIdentifier | string | Need to provide valid MSISDN or SubscriptionId value | Y |
| product.publicIdentifierType | string | Define the type of product.publicIdentifier | Y |
[ 200 ] Prepaid
Note: Below response is for both Retrieve Usage & Get remaining balance for the account.
OK - list request processed successfully, response body contains an entity corresponding to the requested resource.
[
{
"description": "Usage Consumption Report for SubscriptionId S-1001",
"effectiveDate": "2023-03-13T10:54:49",
"@type": "UsageConsumptionReport",
"characteristic": [
{
"value": "Monthly",
"name": "BillingCycleId"
},
{
"value": "11",
"name": "BillingIntervalId"
},
{
"value": "31",
"name": "BillingCycleDuration"
},
{
"value": "27",
"name": "BillingCycleOffset"
},
{
"value": "2023-03-01T00:00:00",
"name": "BillingCycleStartTime"
},
{
"value": "2023-04-01T00:00:00",
"name": "BillingCycleEndTime"
}
],
"bucket": [
{
"id": "1",
"name": "Prepaid Balance",
"usageType": "United States dollar",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "202.2",
"name": "AvailableAmount"
},
{
"value": "2023-02-10T18:16:41",
"name": "StartTime"
},
{
"value": "0",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsPeriodic"
},
{
"value": "true",
"name": "IsPrepaid"
},
{
"value": "false",
"name": "IsPrivate"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "165.41",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "S-1001"
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross",
"value": {
"amount": 0,
"units": "none"
},
"valueName": "Limit"
},
{
"counterType": "Threshold_available_amount",
"level": "Notify_Gross,Notify_BalIncr,Notify_IncrEq",
"value": {
"amount": 20,
"units": "none"
},
"valueName": "20Absolute #514"
},
{
"counterType": "Threshold_available_amount",
"level": "Notify_Gross,Notify_BalIncr,Notify_IncrEq",
"value": {
"amount": 0,
"units": "none"
},
"valueName": "ZeroAbsolute #515"
}
]
},
{
"id": "7",
"name": "Included Minutes - Prepaid",
"usageType": "Voice",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "88888",
"name": "AvailableAmount"
},
{
"value": "2023-02-10T18:17:22",
"name": "BalanceStartTime"
},
{
"value": "2023-03-12T00:00:00",
"name": "StartTime"
},
{
"value": "2023-04-11T00:00:00",
"name": "EndTime"
},
{
"value": "0",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsBillingCyclePeriodic"
},
{
"value": "false",
"name": "IsCompositeMeter"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsOnDemand"
},
{
"value": "true",
"name": "IsPeriodic"
},
{
"value": "true",
"name": "IsPrepaid"
},
{
"value": "false",
"name": "IsPrivate"
},
{
"value": "true",
"name": "IsPurchasedItemCyclePeriodic"
},
{
"value": "false",
"name": "IsRenewable"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "88888",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "S-1001"
}
],
"bucketBalance": [
{
"remainingValueName": "88888 minutes",
"remainingValue": {
"amount": 88888,
"units": "minutes"
},
"validFor": {
"startDateTime": "2023-02-10T00:00:00",
"endDateTime": "2023-03-12T00:00:00"
},
"characteristic": [
{
"value": "88888",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "88888 minutes",
"remainingValue": {
"amount": 88888,
"units": "minutes"
},
"validFor": {
"startDateTime": "2023-03-12T00:00:00",
"endDateTime": "2023-04-11T00:00:00"
},
"characteristic": [
{
"value": "88888",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "true",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0 minutes",
"remainingValue": {
"amount": 0,
"units": "minutes"
},
"validFor": {
"startDateTime": "2023-04-11T00:00:00",
"endDateTime": "2023-05-11T00:00:00"
},
"characteristic": [
{
"value": "0",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross",
"value": {
"amount": 0,
"units": "minutes"
},
"valueName": "Bal"
},
{
"counterType": "Threshold_available_amount",
"level": "Notify_Gross",
"value": {
"amount": 100,
"units": "minutes"
},
"valueName": "recurring minutes threshold"
}
]
},
{
"id": "8",
"name": "Included SMS - Prepaid",
"usageType": "Text",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "999999",
"name": "AvailableAmount"
},
{
"value": "2023-02-10T18:17:22",
"name": "BalanceStartTime"
},
{
"value": "2023-03-12T00:00:00",
"name": "StartTime"
},
{
"value": "2023-04-11T00:00:00",
"name": "EndTime"
},
{
"value": "0",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsBillingCyclePeriodic"
},
{
"value": "false",
"name": "IsCompositeMeter"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsOnDemand"
},
{
"value": "true",
"name": "IsPeriodic"
},
{
"value": "true",
"name": "IsPrepaid"
},
{
"value": "false",
"name": "IsPrivate"
},
{
"value": "true",
"name": "IsPurchasedItemCyclePeriodic"
},
{
"value": "false",
"name": "IsRenewable"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "999999",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "S-1001"
}
],
"bucketBalance": [
{
"remainingValueName": "999999",
"remainingValue": {
"amount": 999999
},
"validFor": {
"startDateTime": "2023-02-10T00:00:00",
"endDateTime": "2023-03-12T00:00:00"
},
"characteristic": [
{
"value": "999999",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "999999",
"remainingValue": {
"amount": 999999
},
"validFor": {
"startDateTime": "2023-03-12T00:00:00",
"endDateTime": "2023-04-11T00:00:00"
},
"characteristic": [
{
"value": "999999",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "true",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0",
"remainingValue": {
"amount": 0
},
"validFor": {
"startDateTime": "2023-04-11T00:00:00",
"endDateTime": "2023-05-11T00:00:00"
},
"characteristic": [
{
"value": "0",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross",
"value": {
"amount": 0,
"units": "none"
},
"valueName": "Bal"
}
]
},
{
"id": "9",
"name": "Included Data - Prepaid",
"usageType": "Data",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "8192",
"name": "AvailableAmount"
},
{
"value": "2023-02-10T18:17:22",
"name": "BalanceStartTime"
},
{
"value": "2023-03-12T00:00:00",
"name": "StartTime"
},
{
"value": "2023-04-11T00:00:00",
"name": "EndTime"
},
{
"value": "0",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsBillingCyclePeriodic"
},
{
"value": "false",
"name": "IsCompositeMeter"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsOnDemand"
},
{
"value": "true",
"name": "IsPeriodic"
},
{
"value": "true",
"name": "IsPrepaid"
},
{
"value": "true",
"name": "IsPrivate"
},
{
"value": "true",
"name": "IsPurchasedItemCyclePeriodic"
},
{
"value": "false",
"name": "IsRenewable"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "4096",
"name": "RolloverInitAmountTotal"
},
{
"value": "4096",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "S-1001"
}
],
"bucketBalance": [
{
"remainingValueName": "4096 megabytes",
"remainingValue": {
"amount": 4096,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2023-02-10T00:00:00",
"endDateTime": "2023-03-12T00:00:00"
},
"characteristic": [
{
"value": "4096",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "4096 megabytes",
"remainingValue": {
"amount": 4096,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2023-03-12T00:00:00",
"endDateTime": "2023-04-11T00:00:00"
},
"characteristic": [
{
"value": "4096",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "true",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0 megabytes",
"remainingValue": {
"amount": 0,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2023-04-11T00:00:00",
"endDateTime": "2023-05-11T00:00:00"
},
"characteristic": [
{
"value": "0",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0 megabytes",
"remainingValue": {
"amount": 0,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2023-05-11T00:00:00",
"endDateTime": "2023-06-10T00:00:00"
},
"characteristic": [
{
"value": "0",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross",
"value": {
"amount": 0,
"units": "megabytes"
},
"valueName": "Bal"
},
{
"counterType": "Threshold_available_amount",
"level": "Notify_Gross",
"value": {
"amount": 100,
"units": "megabytes"
},
"valueName": "recurring data threshold"
},
{
"counterType": "Threshold_consumed_amount",
"level": "Notify_Gross,Notify_BalIncr,Notify_IncrEq",
"value": {
"amount": 75,
"units": "megabytes"
},
"valueName": "75Percent #501"
},
{
"counterType": "Threshold_consumed_amount",
"level": "Notify_Gross,Notify_BalIncr,Notify_IncrEq",
"value": {
"amount": 90,
"units": "megabytes"
},
"valueName": "90Percent #502"
},
{
"counterType": "Threshold_consumed_amount",
"level": "Notify_Gross,Notify_BalIncr,Notify_IncrEq",
"value": {
"amount": 100,
"units": "megabytes"
},
"valueName": "100Percent #503"
},
{
"counterType": "Threshold_available_amount",
"level": "Notify_Gross,Notify_BalIncr,Notify_IncrEq",
"value": {
"amount": 0,
"units": "megabytes"
},
"valueName": "Bal_Zero"
}
]
},
{
"id": "10",
"name": "HotSpot Data - Prepaid",
"usageType": "Data",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "4096",
"name": "AvailableAmount"
},
{
"value": "2023-02-10T18:17:22",
"name": "BalanceStartTime"
},
{
"value": "2023-03-12T00:00:00",
"name": "StartTime"
},
{
"value": "2023-04-11T00:00:00",
"name": "EndTime"
},
{
"value": "0",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsBillingCyclePeriodic"
},
{
"value": "false",
"name": "IsCompositeMeter"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsOnDemand"
},
{
"value": "true",
"name": "IsPeriodic"
},
{
"value": "true",
"name": "IsPrepaid"
},
{
"value": "true",
"name": "IsPrivate"
},
{
"value": "true",
"name": "IsPurchasedItemCyclePeriodic"
},
{
"value": "false",
"name": "IsRenewable"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "4096",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "S-1001"
}
],
"bucketBalance": [
{
"remainingValueName": "4096 megabytes",
"remainingValue": {
"amount": 4096,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2023-02-10T00:00:00",
"endDateTime": "2023-03-12T00:00:00"
},
"characteristic": [
{
"value": "4096",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "4096 megabytes",
"remainingValue": {
"amount": 4096,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2023-03-12T00:00:00",
"endDateTime": "2023-04-11T00:00:00"
},
"characteristic": [
{
"value": "4096",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "true",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0 megabytes",
"remainingValue": {
"amount": 0,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2023-04-11T00:00:00",
"endDateTime": "2023-05-11T00:00:00"
},
"characteristic": [
{
"value": "0",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross",
"value": {
"amount": 0,
"units": "megabytes"
},
"valueName": "bal"
}
]
},
{
"id": "11",
"name": "DataPrioritization Balance - Prepaid",
"usageType": "Data",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "0",
"name": "AvailableAmount"
},
{
"value": "2023-02-10T18:17:22",
"name": "BalanceStartTime"
},
{
"value": "2023-03-12T18:17:22",
"name": "StartTime"
},
{
"value": "2023-04-11T18:17:22",
"name": "EndTime"
},
{
"value": "0",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsBillingCyclePeriodic"
},
{
"value": "false",
"name": "IsCompositeMeter"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsOnDemand"
},
{
"value": "true",
"name": "IsPeriodic"
},
{
"value": "true",
"name": "IsPrepaid"
},
{
"value": "true",
"name": "IsPrivate"
},
{
"value": "false",
"name": "IsPurchasedItemCyclePeriodic"
},
{
"value": "false",
"name": "IsRenewable"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "0",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "S-1001"
}
],
"bucketBalance": [
{
"remainingValueName": "0 megabytes",
"remainingValue": {
"amount": 0,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2023-02-10T18:17:22",
"endDateTime": "2023-03-12T18:17:22"
},
"characteristic": [
{
"value": "0",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0 megabytes",
"remainingValue": {
"amount": 0,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2023-03-12T18:17:22",
"endDateTime": "2023-04-11T18:17:22"
},
"characteristic": [
{
"value": "0",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "true",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0 megabytes",
"remainingValue": {
"amount": 0,
"units": "megabytes"
},
"validFor": {
"startDateTime": "2023-04-11T18:17:22",
"endDateTime": "2023-05-11T18:17:22"
},
"characteristic": [
{
"value": "0",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross",
"value": {
"amount": 0,
"units": "megabytes"
},
"valueName": "bal"
},
{
"counterType": "Threshold_consumed_amount",
"level": "Notify_Gross,Notify_BalIncr,Notify_IncrEq",
"value": {
"amount": 75,
"units": "megabytes"
},
"valueName": "75Percent"
},
{
"counterType": "Threshold_consumed_amount",
"level": "Notify_Gross,Notify_BalIncr,Notify_IncrEq",
"value": {
"amount": 90,
"units": "megabytes"
},
"valueName": "90Percent"
},
{
"counterType": "Threshold_consumed_amount",
"level": "Notify_Gross,Notify_BalIncr,Notify_IncrEq",
"value": {
"amount": 100,
"units": "megabytes"
},
"valueName": "100Percent"
}
]
},
{
"id": "12",
"name": "Included MMS - Prepaid",
"usageType": "Picture",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "999999",
"name": "AvailableAmount"
},
{
"value": "2023-02-10T18:17:22",
"name": "BalanceStartTime"
},
{
"value": "2023-03-12T00:00:00",
"name": "StartTime"
},
{
"value": "2023-04-11T00:00:00",
"name": "EndTime"
},
{
"value": "0",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsBillingCyclePeriodic"
},
{
"value": "false",
"name": "IsCompositeMeter"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsOnDemand"
},
{
"value": "true",
"name": "IsPeriodic"
},
{
"value": "true",
"name": "IsPrepaid"
},
{
"value": "false",
"name": "IsPrivate"
},
{
"value": "true",
"name": "IsPurchasedItemCyclePeriodic"
},
{
"value": "false",
"name": "IsRenewable"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "999999",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "S-1001"
}
],
"bucketBalance": [
{
"remainingValueName": "999999",
"remainingValue": {
"amount": 999999
},
"validFor": {
"startDateTime": "2023-02-10T00:00:00",
"endDateTime": "2023-03-12T00:00:00"
},
"characteristic": [
{
"value": "999999",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "999999",
"remainingValue": {
"amount": 999999
},
"validFor": {
"startDateTime": "2023-03-12T00:00:00",
"endDateTime": "2023-04-11T00:00:00"
},
"characteristic": [
{
"value": "999999",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "true",
"name": "IsCurrentPeriod"
}
]
},
{
"remainingValueName": "0",
"remainingValue": {
"amount": 0
},
"validFor": {
"startDateTime": "2023-04-11T00:00:00",
"endDateTime": "2023-05-11T00:00:00"
},
"characteristic": [
{
"value": "0",
"name": "ThresholdLimit"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "false",
"name": "IsCurrentPeriod"
}
]
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross",
"value": {
"amount": 0,
"units": "none"
},
"valueName": "Bal"
}
]
}
]
}
][ 200 ] POSTPAID
Note: Below response is for both Retrieve Usage & Get remaining balance for the account.
OK - list request processed successfully, response body contains an entity corresponding to the requested resource.
[
{
"description": "Usage Consumption Report for MSISDN 8201",
"effectiveDate": "2022-11-08T11:52:48",
"@type": "UsageConsumptionReport",
"characteristic": [
{
"value": "Monthly",
"name": "BillingCycleId"
},
{
"value": "1",
"name": "BillingIntervalId"
},
{
"value": "30",
"name": "BillingCycleDuration"
},
{
"value": "7",
"name": "BillingCycleOffset"
},
{
"value": "2022-11-01T00:00:00",
"name": "BillingCycleStartTime"
},
{
"value": "2022-12-01T00:00:00",
"name": "BillingCycleEndTime"
}
],
"bucket": [
{
"id": "1",
"name": "Postpaid Balance",
"usageType": "United States dollar",
"isShared": false,
"@type": "BucketBalance",
"characteristic": [
{
"value": "infinity",
"name": "AvailableAmount"
},
{
"value": "infinity",
"name": "CreditLimit"
},
{
"value": "false",
"name": "IsCreateExternalPaymentRequest"
},
{
"value": "false",
"name": "IsPeriodic"
},
{
"value": "false",
"name": "IsPrepaid"
},
{
"value": "false",
"name": "IsPrivate"
},
{
"value": "false",
"name": "IsVirtual"
},
{
"value": "0",
"name": "ReservedAmount"
},
{
"value": "infinity",
"name": "ThresholdLimit"
}
],
"product": [
{
"publicIdentifier": "8201"
}
],
"bucketCounter": [
{
"counterType": "Threshold_credit_limit",
"level": "Notify_Gross,Notify_IncrEq,Notify_DecrEq",
"value": {
"amount": "infinity",
"units": "none"
},
"valueName": "Limit"
}
]
}
]
}
]Definitions
Each of the request parameters is detailed.
| description | string | Free short text describing the usage consumption report content.Concatenate “Usage Consumption Report for” + “MSISDN/SubscriptionId” + For eg\: "Usage Consumption Report for subscriptionId 1142318979871" | N |
|---|---|---|---|
| effectiveDate | Datetime | Date and time when the usage consumption report was calculated and generated. | N |
| @type | string | Hard coded value "UsageConsumptionReport". | N |
| characteristic | array | Describes a given characteristic of an object or entity through a name/value pair | N |
| characteristic.name | array | Name of the characteristic | N |
| characteristic.value | array | The value of characteristic | N |
| bucket | array | A list of usage volume products (UsageVolumeProduct [*]). Bucket(s) included in the offer or option subscribed | N |
| bucket.id | string | Resource Id of the bucket. | N |
| bucket.name | string | Name of balance as defined in My MATRIXX. eg: Hotspot usage, Internet usage,Prepaid Balance | N |
| bucket.usageType | string | Class name of balance as defined in My MATRIXX. such as voice, sms, data | N |
| bucket.isShared | boolean | True if the balance is an aggregate balance. False otherwise. | N |
| bucket.@type | string | hardcoded to "BucketBalance" | N |
| bucket.characteristic | array | Describes a given bucket characteristic of an object | N |
| bucket.characteristic.value | string | The value of characteristic | N |
| bucket.characteristic.name | string | Name of the characteristic | N |
| bucket.product | array | A network product reference (NetworkProductRef). Public identifier associated to the product for which the consumption counter is detailed. | N |
| bucket.product.publicIdentifier | string | Public number associated to the network product(msisdn number for mobile line for example). | N |
| bucket.bucketCounter | string | The consumption counters (called ConsumptionSummary in the SID model) detail for example the different kind of consumption done on the bucket | N |
| bucket.bucketCounter.counterType | string | Type of the consumption counter. We can give for example a counter of the used value for a bucket (counterType=used for example) or the value of the consumption done out of the bucket(s) (counterType=outOfBucket for example). | N |
| bucket.bucketCounter.level | string | Counter level. The counter can be given globally for the bucket or detailed by user or by network product for example in case of shared bucket. | N |
| bucket.bucketCounter.value | object | Numeric value of the bucket counter in a given unit | N |
| bucket.bucketCounter.value.amount | integer | value of the bucket | N |
| bucket.bucketCounter.value.units | string | unit of the value | N |
| bucket.bucketCounter.valueName | string | Value of the counter in a formatted string used for display needs for example. | N |
| bucket.bucketBalance | array | List of bucket balance | N |
| bucket.bucketBalance.remainingValueName | string | Remaining amount in a formatted string for the bucket given in the balance unit (for example 1.9 Gb) | N |
| bucket.bucketBalance.remainingValue | object | Indicate the amount on the bucket | N |
| bucket.bucketBalance.remainingValue.amount | float | Balance amount for this interval | N |
| bucket.bucketBalance.remainingValue.unit | float | Quantity unit of the balance. | N |
| bucket.bucketBalance.validFor | object | period for which the balacne in the bucket is valid | N |
| bucket.bucketBalance.validFor.startDateTime | string | The start time of this balance interval | N |
| bucket.bucketBalance.validFor.endDateTime | string | The end time of this balance interval | N |
| bucket.bucketBalance.characteristic | array | Describes a given bucketBalance characteristic of an object | N |
| bucket.bucketBalance.characteristic.name | string | Name of the characteristic | N |
| bucket.bucketBalance.characteristic.value | string | Value of the characteristic | N |
characteristic data model:
| name | type | description | required |
|---|---|---|---|
| characteristic.name | String | BillingCycleId(The ID of the billing cycle template.) | N |
| characteristic.value | string | Monthly | N |
| characteristic.name | string | BillingIntervalId(Interval Id for billing cycle period.) | N |
| characteristic.value | String | 1 | N |
| characteristic.name | String | BillingCycleDuration (Duration of current period in days.) | N |
| characteristic.value | String | 30 | N |
| characteristic.name | String | BillingCycleOffset (Count of number of complete days into current period.) | N |
| characteristic.value | string | 7 | N |
| characteristic.name | String | BillingCycleStartTime(Start date of the current billing period.) | N |
| characteristic.value | string | 2022-11-01T00:00:00 | N |
| characteristic.name | String | BillingCycleEndTime(End date of the current billing period.) | N |
| characteristic.value | string | 2022-12-01T00:00:00 | N |
bucket.characteristics data model:
| name | type | description | required |
|---|---|---|---|
| characteristic.name | String | AvailableAmount (The amount available to use based on the current active balance value, the balance credit limit and, for aggregated balances, the credit limit of any parents. If rollover is allowed for this balance, the sum of all the valid rollover balances from prior periods is included in this field.) | N |
| characteristic.value | string | 208811.96 | N |
| characteristic.name | string | StartTime (When the balance amount becomes valid. If not present, balance is valid from start of time. For periodic balances, this is the the start validity of the period slot selected based on the time of the request.) | N |
| characteristic.value | String | 2022-08-30T05:07:14 | N |
| characteristic.name | String | CreditLimit(The current credit limit value on the balance.) | N |
| characteristic.value | String | 0 | N |
| characteristic.name | String | IsCreateExternalPaymentRequest(True - indicates balance is associated with an external payment method, so an External Payment Request will be created to request for the payment. Otherwise it is not associated with an external payment method.) | N |
| characteristic.value | boolean | false | N |
| characteristic.name | String | IsPeriodic(True if the balance is a periodic balance. False otherwise.) | N |
| characteristic.value | boolean | false | N |
| characteristic.name | String | IsPrepaid(True if the balance is a pre-paid amount. False otherwise.) | N |
| characteristic.value | boolean | true | N |
| characteristic.name | String | IsPrivate(True - indicates a private balance otherwise it is not private balance) | N |
| characteristic.value | boolean | false | N |
| characteristic.name | String | IsVirtual( True if the balance is a virtual balance. False otherwise.) | N |
| characteristic.value | boolean | false | N |
| characteristic.name | String | ReservedAmount(The additional quantity reserved by current activity. For periodic balances, this is the reserved value in the period slot at the time of the request.) | N |
| characteristic.value | String | 0 | N |
| characteristic.name | String | ThresholdLimit(The current threshold limit value on the balance.) | N |
| characteristic.value | String | 208768.97 | N |
| characteristic.name | String | RolloverInitAmountTotal: Sum of the rollover balances at the start of the current interval. | N |
| characteristic.value | String | 4096 | N |
bucketBalance.characteristic data model:
| name | type | description | required |
|---|---|---|---|
| characteristic.name | String | ThresholdLimit: The current threshold limit value of this balance interval, 99999 indicates Unlimited | N |
| characteristic.value | String | 99999 | N |
| characteristic.name | String | ReservedAmount: The additional quantity reserved by current activity for this balance interval. | N |
| characteristic.value | String | 0 | N |
| characteristic.name | String | IsCurrentPeriod: True for current period, false for other periods. Not set for on-demand balance periods. | N |
| characteristic.value | String | Possible values are: true, false | N |
Possible Error Scenarios:
Bad Request [400]
{
"errors": [
{
"code": 400,
"message": "The request is invalid or not properly formed.",
"description": "The client sent too many requests and server is not able to serve them all at the moment"
}
]
}
#### Unauthorized [401]
{
"errors": [
{
"code": 404,
"message": "The user could not be authenticated for this request.",
"description": "The request has not been applied because it lacks valid authentication credentials for the target resource"
}
]
}
#### Not Found [404]
{
"errors": [
{
"code": 404,
"message": "MATRIXX:QUERY_USAGE_ERROR",
"description": "Subscriber not found (ExternalId=xxxx)"
}
]
}
#### Not Found [404]
{
"errors": [
{
"code": 404,
"message": "APIKIT:METHOD_NOT_ALLOWED",
"description": "HTTP Method xxx not allowed for : /{businessId}/queryUsageConsumption"
}
]
}